BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / becproto.zip / SK&J0126.ZIP / JBATCH.DOC < prev next >

Wrap

Text File | 1989-01-26 | 31KB | 689 lines

JBatch v1.19 MiniNet's Driver for Richard B. Johnson's Jmodem Protocol Protocols Supported: Jmodem - Batch or Single File Copyright 11/01/1988, 1989 by Crater Rim Software. All Rights Reserved. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = JBatch Licensing Agreement -------------------------- This program is the sole property of Crater Rim Software. For the sake of clarity, all references and restrictions to the use of JBatch also apply to any and all of the associated support files (included with or created by) JBatch. JBatch, its overlays and all of its associated support files are not public domain software, nor are they free software. JBatch is copyright (c) 1988,89 by Crater Rim Software. All rights reserved. Users are granted a limited license to use JBatch free of charge BUT subject to the following limitations: No user may modify JBatch in any way, including but not limited to decompiling, disassembling or otherwise reverse engineering the program. JBatch must be copied in unmodified form, complete with the file containing this license information. Any and all JBatch documentation must be included with the copy. No fee, charge or other compensation may be accepted or requested by any licensee. JBatch may not be distributed in conjunction with any other product without prior arrangements with Crater Rim Software. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ********* ALL THIS IS SAYING IS THAT I WANT TO KNOW WHO HAS ********* ********* (and is using) THIS FILE! NOTHING MORE... ********* * * * Operators of electronic bulletin board systems (Sysops) may post * * JBatch for downloading by their users and may use the JBatch * * module only as long as the above conditions are met and Crater * * Rim Software has been notified of your intent to use JBatch * * * ******** ALL THIS IS SAYING IS THAT I WANT TO KNOW WHO HAS ********** ******** (and is using) THIS FILE! NOTHING MORE... ********** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Those organizations who distribute public domain or user supported software on a pay per diskette basis may distribute copies of JBatch under the above conditions ONLY AFTER OBTAINING WRITTEN PERMISSION from Crater Rim Software. Such permission usually is granted. Please write or call for details. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Software Discalaimer and Warranty Crater Rim Software makes no warranty of any kind, express or implied, including without limitation, any warranties of merchantability and/or fitness for a particular purpose. Crater Rim Software shall not be liable for any damages, whether direct, indirect, special or consequential arising from a failure of this program to operate in the manner desired by the user. Crater Rim Software shall not be liable for any damage to data or property which may be caused directly or indirectly by use of the program. IN NO EVENT WILL Crater Rim Software BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = JBatch v1.14 MiniNet's Protocol Driver for Jmodem Batch Memory requirements: JBatch requires a minimum of 103K (105,472 bytes) to perform transfers. If you don't know how much memory you have available, it can be checked easily as follows: 1) Copy DOS' CHKDSK.COM to your comm directory. 2) Start up your comm program and execute the comm program's DOS shell option. 3) Type CHKDSK at the DOS prompt 4) CHKDSK will display its results along with the "bytes free" figure. The "bytes free" must be at least 105,472. 5) Enter "EXIT" at the DOS prompt. 6) Exit your comm program... Command line parameters : M Monitor Carrier, abort if not present. Including this parameter allows you to use JBatch to transfer files between systems via null modem cable. Default is ON (Monitor Carrier). Dx Direction of transfer. Where x = R (receive) or S (send) F The F parameter is used as a flag for JBatch and denotes that all paramters after the F parameter are to be processed as filenames. name [d:\path\]Filename to send/receive. or @drive:\path\]Filelist of files to Batch send. or @drive:\path\]Filelist@drive:\path filelist of files (residing in the second drive:\path directry) to Batch send. Px Comm Port to use. Where x = 1 or 2 Sbaud Modem Speed. Where baud = 300, 1200, 2400, 4800, 9600, 19200 Y Override Overwrite Flag JBatch allows you to specify if you want overwriting of existing files to be performed. By including the Y parameter on the command line, the default overwrite setting will be reversed during the current BATCH transfer. In single file mode, the Jmodem Protocol Module is fully compatible with its stand-alone counterpart used on all/most BBS. Both systems must be using JBatch to invoke the Jmodem Batch Mode. B Override Batch Mode Flag The default setting for JBatch is Batch Mode. By including the B parameter on the command line, JBatch will perform the transfer in Single File mode. If the B is omitted, JBatch defaults to batch mode. Nx Node Letter or Number. Where x = A to Z or 0 to 9 @ Modify logfile name/xferfile name/path to JBA.COM/options flags... Clone JBATCH.COM if changes are made Note: As is the case with Jmodem, the default colors of JBatch are Black text on a White background. The colors cannot be changed. The D, P and S parameters MUST be supplied... if operating in single file mode, the F and B parameters must be supplied. The Y, M and N parameters are optional... and the @ parameter is only used to review/modify the default settings (see modification mode below). The DR and DS parameters are mutually exclusive (only one, but not both) Command Line parameters may be supplied as upper or lower case, and may be entered in any order. JB.LOG - JBatch will record transfer results to the logfile in the following format: +--- Transfer Direction | +------- File Size (0 if transfer fails) | | +---------- Modem Speed | | | +---------- CPS efficiency (0 if transfer fails) | | | | +--- Filename | | | | | +- Protocol | | | | | | +-- If Batch Mode | | | | | | | S 27648 1200 bps 108 cps C:\DLS\JBATCH.ARC - Jmodem Batch XFER.TXT - If (and only if) a Node character is specified, JBatch will also create a Xfer Node File to show success/failure status messages. This file has the following format : Filename Upload or Download Protocol (Jmodem or JBatch) Success or Fail EOF (^Z) Sample: JBATCH.ARC Download JBatch Success ^Z The file will be created in the default directory if no drive/path is specified during the command line @ parameter modification mode. While in batch mode, only the last file transfer results will be logged to this file. However, JB.LOG will contain the results of all files transferred in the batch. Command Line @ Parameter Modification Mode. Starting JBatch with the @ command line parameter will put JBatch into its default modification mode. JBatch will first display its current default settings and then prompt you for any changes you may wish to make. Note that entering a blank line (simply hitting [Enter]) will leave the current setting intact. JBatch allows modification of the logfile name, the xfer file name (for BBS use) and certain operational flags. J - JB Path: Although in most cases, you will be storing JBA.COM in the same directory as your comm/BBS program files, there are cases where you may want to store JBA.COM in a directory other than the logged directory. The JB Path allows you to do this. When JBatch begins the actual Jmodem transfer, it shells out to DOS and loads the JBA.COM module. If a JB Path has been defined, JBatch will prefix the JBA.COM with this path. If, after defining a path, you decide that it is NOT required, simply enter a backslash \ for the new path. This will cause JBatch to null out any existing path. L - Logfile Name: This is the filename JBatch uses to record the results of any tranfers it performs. JBatch will accept upto 40 characters so you may include a full drive:\path\ along with the logfile name. Additionally, you may use a question mark (?) as one (and only one) of the logfile name characters. If a question mark is present, JBatch will substitute the Node character in its place. If no node character is specified, JBatch will use the letter A as a Node character. The letter A is substituted ONLY if the question mark is encountered in the logfile name. If you do not want JBatch to maintain a logfile, simply enter a backslash (\).. which will inform JBatch to blank out the logfile name. The default logfile name is JBatch.LOG X - XferFile Name: This is the filename JBatch uses to record transfer results for use by BBS programs. Its format and modification is identical to the Logfile Name. The default Xferfile name is XFER.TXT O - Overwrite: This flag setting tells JBatch whether or not in can overwrite existing files during Batch mode transfers. If the Overwrite flag is set (YES), JBatch will erase any duplicate file prior to beginning the transfer of the new same-filename file... thus eliminating the presence of any *.OLD files. The default is NO S - Save Aborts: This flag setting tells JBatch whether or not it should keep any partial files which were aborted during transfer. This flag holds for batch mode only. When operating in batch mode, JBatch sends both the filename and filesize to the receiving system. Upon completion (or abort), JBatch checks the size of the transported file against the actual filesize sent with the filename. If the the filesizes are not the same (the actual filesize is less than the filesize sent with the filename) ... and the Save-Aborts flag is off (NO)... JBatch will erase the partial file. Understand that this process takes place only on the receiving end! The default is YES W - Write On 0: This flag setting tells JBatch whether or not it should create the XferFile when a transfer is not successfully completed. The status of this flag is the last check that JBatch makes before creating the XferFile. A node character and XferFile Name must be specified before the Write On 0 flag comes into play. The default is YES [Enter] Quit: If you only wish to view the current default settings, simply hit [Enter] to exit back to DOS. If any changes have been made, JBatch will go into its cloning mode and ask if you want to clone JBatch to preserve the new changes. Note that you MUST press the Y key in order to clone JBatch. Hitting [Enter] here will simply return you to DOS without saving your changes within the JBatch program. Program control keys: JBatch will recognize either the [Esc] key or ^X (control X) key during transfers and will abort the current transfer, returning you to DOS. I have modified the Jmodem module (JM.COM) to eliminate as much as the delays as possible... making the batch mode cycling quite "brisk"! Note however that there is a delay if the transfer is aborted for any reason... this is due to the fact that the buffers have to be "drained" before recycling. Batch transfers: JBatch is capable of sending and receiving multiple files in batch mode. Since this protocol driver was written for use with my MiniNet BBS package... the sending of the file creation date (ala DSZ and Telink) tends to drive me up the wall, creating quite a bit of confusion in keeeping track of newly acquired files! For this reason the major difference between JBatch Batch mode and other Batch modes is that JBatch Batch only sends the File Name and filesize and does not send the file creation date. During Batch mode transfers, JBatch will display the last 3 files requested under the JBatch logo so that you may have a running update of what's happening. The present transfer progress is displayed in its own window alongside the JBatch logo. Upon completion, JBatch will display the transfer efficiency (CPS) alongside the filename. Receiving files in Batch mode: You do not have to supply any filename during batch mode receives. You may of course, include a full drive:\path\ in place of a filename. Use the F command line parameter to designate the path in the form: f C:\FOO\BAR (with or without the trailing backslash) Sending files in batch mode: You may use any valid DOS wildcard configuration with the F parameter. Additionally, you may specify a list of filenames for JBatch to send. The list filename is specified as @drive:\path\listfilename You may of course, include a full drive:\path\ when using the @ option. The filenames in the list may contain a full drive:\path\ (the same or different) for each filename or you may supply an external path when using the @C:filelist option in either batch upload or download modes. The format is @C:[path]filelist@C:path JBatch is capable of reading and extracting filenames from a standard - single line - BBS files listing. If you use a BBS type files listing, and call JBatch from the comm or BBS directory, you will have to add the full drive:\path\ to each filename in the list if the files to send do not reside in the default directory. There are other ways of accessing files that reside in directories other than the default (default upload and download directories, etc.), but I won't go into this area as most comm and BBS programs do this work for you (K9X does it ALL for you... automatically!) Examples: 1. Use COM1, 1200 baud, Send file MYFILE.DOC in single file mode JBATCH p1 s1200 b dS f MYFILE.DOC 2. Use COM2, 19200 baud, Batch Receive files *.DOC, do not monitor carrier, override the default "do not overwrite". JBATCH p2 s19200 Y dR m 3. Use COM1, 9600 baud, Batch Send files in MYLIST.LST which resides in my C:\BBS\ directory. The files listed in MYLIST.LST reside in various directories on different drives. Do not monitor carrier and record success results to Node A of my BBS. JBATCH p1 s9600 dS m nA f @C:\BBS\MYLIST.LST C:\BBS\MYLIST.LST looks like this: ABC.ARC (this one resides in the default directory) D:\FOO\BAR\MYGAME.EXE E:\LOTUS\123GRAPH.ARC XFER.TXT (or XFER-A.TXT if ? specified in the default xferfile name) will reflect the results of the transfer. Note that only the last filename and its transfer results will be present in XFER.TXT. JB.LOG will however, contain the results of all three files. 4. Use COM1, 9600 baud, Batch Send files in MYLIST.LST which resides in my C:\BBS\ directory. The files listed in MYLIST.LST reside in my C:\UPLOADS directory. Record success results to Node A of my BBS. JBATCH p1 s9600 dS nA f @C:\BBS\MYLIST.LST@C:\UPLOADS C:\DLS\MYLIST.LST looks like this: ABC.ARC MYGAME.EXE 123GRAPH.ARC XFER.TXT (or XFER-A.TXT if ? specified in the default xferfile name) will reflect the results of the transfer. Note that only the last filename and its transfer results will be present in XFER.TXT. JB.LOG will however, contain the results of all three files. 5. Use COM2, 19200 baud, Batch Send only files containing an ARC extension and residing in my C:\DLS directory, and don't monitor carrier. JBATCH p2 s19200 dS m f C:\DLS\*.ARC 6. Use COM2, 19200 baud, Batch Mode Receive files and store them in my C:\DLS directory. JBATCH p2 s19200 dR f C:\DLS 7. Use COM1, 2400 baud, Receive MYFILE.ARC in single file mode and store it in my C:\DLS directory. JBATCH p2 s2400 b dR f C:\DLS\MYFILE.ARC There are 3 sample batch files included in JBATCH.ARC SJ.BAT - this batch file is set up for sending file(s) to another system RJ.BAT - this batch file is set up to receive file(s) from another system RSJ.BAT - this batch file will handle transfers in either direction Executing any one of the batch files without any parameters (or the wrong parameter) will display a short message showing the correct calling procedure and parameter choices. Since RJS.BAT handles transfers in either Send or Receive mode, it naturally requires more information in order to perform correctly. NOTE: If you are operating a MiniNet BBS v18.00 or above... or K9X v8.00 or above... access to JBatch is handled internally and does not require the use of the batch files. If you are not... please read the enclosed PRODUCTS.TXT file... It's worth a look! For pure BBS'ing, K9X can't be beat! ------------------------------------------------------------------------------ Jbatch v1.15 Dated 11/02/88 1) Repaired two minor bugs. 2) Single file transfers in earlier versions of JBatch had no way of detecting an aborted transfer... thus, ALL single file transfers were recorded as successful. Version 1.15 corrects this problem by creating a 0 byte file upon successful JB completion. The presence of the 0 byte file is checked after each execution of JB.COM. If present, the transfer was successful. If a download is not successful and the "save aborts" flag is off, JBatch will automatically erase the partial file. 3) In order to facilitate the use of JBatch in a multinode BBS environment the JB.COM module has been renamed JBA.COM. In a multinode BBS environement, JBatch v1.15 requires the presence of an exclusive copy of JBA.COM for each node. Each JB module is named according to the BBS node it supports (JBA.COM supports node A, JBB.COM supports node B, JB1.COM supports node 1, etc.). To facilitate a simple patching of JBA.COM for the other nodes, the file PATCHJB.COM is included. To create multiple node copies of JBA.COM simply run PATCHJB as PATCHJB node where node equals A thru Z or 0 thru 9. PATCHJB will insert the node character into the JBA.COM module and rename the JBA.COM file to JB + node character + .COM. Example: Create as JB module to support node C. 1) type PATCHJB C at the DOS prompt 2) PATCHJB modifies JBA.COM replacing the default A with the new C 3) PATCHJB renames JBA.COM to JBC.COM If no node character is specified on the JBatch command line (the n parameter), JBatch will use the A character... as you have probably surmised, JBatch appends the node character (or temporary A) to the JB module (JBA, JBB, JB1, etc). Two cautions... PATCHJB requires the original JBA.COM and will rename the original JBA.COM to JBwhatever.COM... Be sure you use a copy of the original! If you haven't any use for mutiple copies of JBA.COM, simply copy JBA.COM down into your comm directory and use it. The default is JBA.COM Jbatch v1.16 Dated 11/05/88 Changes made per request of Bob Rapp... Jbatch is now able to handle multiple filenames on the command line. The command syntax remains the same but if more than one filename is specified, JBatch will create its own BATCHLST file. If a Node character is specified on the command line, that character will be used for the extension of BATCHLST. The default is "A" if no node character is specified. The number of filenames that can be specified will depend largely on your own particular system setup, the string length used by your calling program and the individual filename lengths. This feature is only active while in Batch Send Mode (receive automatically gets filename from sender), the command line paramaters can be in any order, NO WILDCARDS ARE ALLOWED and EACH filename may include a full path. Your command line should look like ... JBATCH DS P1 S9600 f FILE1 FILE2 FILE3 Since the BATCHLST is created internally (by JBatch), Jbatch will erase the BATCHLST file once it is done with it... You may override this by including an E as one of the command line paramters. NOTE: These changes only effect the operation of JBatch when multiple filenames are specified on the command line. Operation of JBatch in "normal" operation, remains as it was before. Jbatch v1.17 Dated 12/04/88 Modified the use of the @C:filelist option in order to pull JBatch into line with DSZ and RBBS. The command syntax has been changed: old - f@C:C:\WORK\filelist new - f @C:\WORK\filelist or old - f@C:C:\WORK\filelist@C:D:\PLAY new - f @C:\WORK\filelist@D:\PLAY As you can see, instead of looking for an @C: string to designate the use of a filelist and optional path to the files to be send (the second @C:), JBatch now checks for the @ as the first character and the : as the third character for both the filelist and optional files path. Added a new Command Line Paramter for Use with RBBS-PC. RBBS-PC utilizes a true Batch download with a single file mode upload. During uploads, RBBS-PC includes the full path and filename for the f paramter. Since JBatch Batch mode is a TRUE Batch in both downloads and uploads, I have added the R command line switch to tell JBatch that the F parameter may (or may not) include a filename. When JBatch sees the R parameter, it will look for the last \ or : characters and parse all character after that, thus leaving just the download path... which it then appends to any uploads. The default is True (non RBBS-PC) batch uploads. RBBS command line for Batch Receive using JModem Batch JBATCH.COM p[PORT#] s[BAUD] dr r n[NODE] f [FILE] RBBS command line for Batch Receive using JModem Batch JBATCH.COM p[PORT#] s[BAUD] ds r n[NODE] f [FILE] example: RBBS-PC passes [FILE] as C:\RBBS\99\filename.ext (or your defined upload path) during uploads exclusion of the R command line parameter results in an invalid file specification of C:\RBBS\99\filename.ext\ inclusion of the R command line parameter results in a valid file specification of C:\RBBS\99\ for obvious reasons, if you use the R command line parameter, you must include the last \ or at least one superflous (non \ or : character) at the end of the F specification. when using the R paramter... valid C:\RBBS\99\*.* results in C:\RBBS\99\ valid C:\RBBS\99\ABC.ARC results in C:\RBBS\99\ valid C:\RBBS\99\ results in C:\RBBS\99\ invalid C:\RBBS\99 results in C:\RBBS\ no f parameter results in *.* (all files saved in logged drive\dir) when using the default (non RBBS-PC) invalid C:\RBBS\99\*.* results in C:\RBBS\99\*.*\ invalid C:\RBBS\99\ABC.ARC results in C:\RBBS\99\ABC.ARC\ valid C:\RBBS\99\ results in C:\RBBS\99\ valid C:\RBBS\99 results in C:\RBBS\99\ no f parameter results in *.* (all files saved in logged drive\dir) JBatch v1.18 Dated 12/17/88 Modified the use of the f (filespec) parameter. As of this version, JBatch will assume that all command line parameters after the single f parameter are filenames or filespecs. If in receive mode and no filespec(s) are present, JBatch will assign a *.* as the default filespec. If in upload mode and no filespec(s) are present, JBatch will abort. What this means is that the f command line paramter and filespec(s) must be the last command line parameters supplied. Examples: Batch Receive files to directory C:\DLS JBATCH p1 s2400 dr f C:\DLS Batch Receive files to logged directory JBATCH p1 s2400 dr f Batch Send C:\ULS\FILE1.ARC and D:\FOO\FILE2.ARC JBATCH p1 s2400 ds f C:\ULS\FILE1.ARC D:\FOO\FILE2.ARC Batch Send D:\FOO\*.* JBATCH p1 s2400 ds f D:\FOO\*.* JBatch v1.19 Dated 1/26/89 - Changes made per request of Don Smith Corrected a slight bug in which JBatch would report an abnormal CPS count. I suspect this was caused by an immediate abort or by a transfer which began before midnight and ended after midnight. In any case, JBatch will report a 1 byte CPS in these cases. Added the JB Path parameter to the JBATCH @ configuration section. NOTE: If you have JBA.COM in a directory OTHER than your logged directory, be sure to start up JBATCH as JBATCH @ and designate the FULL path to JBA.COM Added the node charcater to the transfer window frame for those SysOps who are operating multiple nodes in a networking environment. Added ErrorLevel exit. If ALL transfers are successful, JBatch will return an ERRORLEVEL 0 If ANY ONE of the transfers are not successful, JBatch will return an ERRORLEVEL 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - N O T I C E N O T I C E N O T I C E N O T I C E N O T I C E Due to the amount of time and money I have spent setting up JBatch for use with your Comm/BBS programs, I am requesting that you please send a small contribution ($25.00 suggested) to compensate for the man hours I have spent developing, modifying and setting up this protocol driver. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - All suggestions are gratefully received and reviewed! Sysops, Let me know... Sal Manaro dba Crater Rim Softare 4028 41st Ave South Seattle, Wa 98118 (206) 723-6728 (voice) Underdog's MiniNet (206) 725-9233 (data) 1200/2400/9600 24hrs 600 megs OnLine Supporting 22 files transfer protocols Enjoy, Sal Manaro